home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / rafbst20.zip / RAFBSTAT.DOC < prev    next >
Text File  |  1990-11-04  |  9KB  |  285 lines
  1.  
  2. ------------------------------------------------------------------------------
  3.                               RaFbStat v2.0
  4.  
  5.                Files Database Statistics Bulletin Generator
  6.  
  7.                     Copyright (C) 1990  Foxtrot Software
  8.                            All Rights Reserved
  9.  
  10.   This is a shareware program, this program is not to be sold or modified
  11. in any way.  You are free to use, copy and distribute RaFbStat as long as:
  12.  
  13.   a.  No fee is charged for use of the program or the documentation.
  14.       A fee may be charged for copying or distibution of this software
  15.       and documentation for others not to exceed US$ 10.00.
  16.  
  17.   b.  It is not modified in any way.
  18.  
  19.   c.  This software and documentation or either is not used commercially.
  20.  
  21.   d.  You distribute this software along with all documentation and
  22.       registration forms unmodified.
  23.  
  24.   The Author hereby disclaims all warranties relating to this software,
  25. whether expressed or implied, including without limitation any implied
  26. warranties of merchantability or fitness for a particular purpose.  The
  27. author will not be liable for any special, incidental, consequenctial,
  28. indirect or simular damages due to loss of data or any other reason.  The
  29. user of this software bears all risk as to the quality  and performance
  30. of this software.
  31.  
  32. -------------------Now that we have that out of the way-----------------------
  33.  
  34.   If you have any comments or suggestions for improvement of this software,
  35. you can contact me at The Foxtrot BBS, data: (914 )567-1814, 24 hours a
  36. day or leave Net-Mail @FIDO NET 1:272/26, @MagNet 100:900/39, @IS-Net
  37. 40:1914/1 or 40:1914/12.
  38.  
  39.   If you like this software, and decide to keep it on your system and
  40. to use it, then send $8.00 (Check or M.O.) for registration to the address
  41. listed below.  
  42.  
  43.   Copies of all source code for RaFbStat is available.  Please write or NetMail
  44. me at the following addresses for more information on this offer:
  45.  
  46. Foxtrot Software           or       Byron Copeland
  47. 11 Y Street                         The Foxtrot BBS (1:272/26)
  48. New Windsor, Ny.  12553             Data: (914)567-1814 24 hours
  49.  
  50. Thank you for your support.
  51.  
  52. ------------------------------------------------------------------------------
  53.  
  54. 1. Introduction.
  55.  
  56.    RaFbStat is a utility that will allow the Sysop of a RemoteAccess BBS
  57. to produce a Files Area Statistic Report of the following:
  58.  
  59.    1)  Total files in all selected areas.
  60.    2)  Total bytes in all selected areas.
  61.    3)  Total files for each area selected.
  62.    4)  Total bytes for each area selected.
  63.    5)  Percentage of the total files that each area contains.
  64.  
  65.    Selected areas are determined by using Security and Flags settings
  66. configured in the RAFBSTAT.CTL file.  Areas that don't match the criteria
  67. specified will not be processed.
  68.  
  69.    The report is usually placed in same directory as all other text files
  70. so a menu option can be built to allow a user to view the Bulletin.
  71.  
  72.    RaFbStat is designed to be run during a maintenance event when no
  73. callers are using your system.  Thus, RaFbStat has no code to handle
  74. file sharing in a multitasking environment.
  75.  
  76.    This version of RaFbStat is for use with Version 0.04a of RemoteAccess
  77. BBS and versions that conform to the structs of that version.
  78.  
  79.  
  80. 2.  Version 2.0 Enhancments.
  81.  
  82.     1)  Automatic RA System Area detection.
  83.     2)  Allow user control of which .Ctl file to use for execution.
  84.     3)  Security and Private Security checks now configurable.
  85.     4)  Flags and Private Flags now configurable.
  86.  
  87.  
  88. 3.  Files needed by RaFbStat:
  89.  
  90.        INPUT:
  91.  
  92.          FILES.RA    -  The filename of your Files Configuration.
  93.  
  94.          RAFBSTAT.CTL -  Control file for RAFBSTAT.  Or any .CTL file
  95.                          that is defined on the command line when executed.
  96.  
  97.        OUTPUT:
  98.  
  99.          BULLETIN.ANS
  100.          BULLETIN.ASC -  A bulletin file that you will specify in
  101.                          RAFBSTAT.CTL file.  Actually two files will
  102.                          be created as output.  One is a plain ascii
  103.                          file, the other will contain ansi screen
  104.                          commands for color.  When specifying the
  105.                          filenames, DO NOT append .ASC or .ANS.
  106.                          RAFBSTAT will append an extension for you.
  107.  
  108.         
  109.  
  110. 4.  Setup.
  111.  
  112.     a.  An Editor that will create text files, such as EDLIN, GALAXY,
  113.         or any Editor that will allow CR/LF combinations at the end of each
  114.         line has to be used.  Create the RaFbStat.Ctl file in your RA BBS
  115.         System directory with the following information:
  116.  
  117.         Line 1: Full Pathname of the Bulletin filename you wish to use.
  118.         Line 2: Name of your BBS. (55 Chars max)
  119.         Line 3: Security required to be processed.
  120.         Line 4: Security Flags required to be processed.
  121.         Line 5: Private Security Level required to be processed.
  122.         Line 6: Private Security Flags required to be processed.
  123.         Line 7 - 26:  File Extensions that you wish to have included in the
  124.                       Bulletins.
  125.  
  126. An example of the RaFbStat.Ctl File:
  127.  
  128. BULLETPATH : D:\RA\Txtfiles\Bullet10
  129. BBSNAME    : The Foxtrot BBS * New Windsor, Ny.
  130. NORMALSEC  : 10
  131. NORMALFLAGS: -------- -------- -------- --------
  132. PRIVSEC    : 100
  133. PRIVFLAGS  : -------- -------- -------- --------
  134. EXE
  135. ZIP
  136. LZH
  137. ARC
  138. PAK
  139. TXT
  140. DOC
  141. ZOO
  142.  
  143.  
  144.  
  145. 5.  Security Flags.
  146.  
  147.     a.  Flags and PrivateFlags take on the following meaning:
  148.  
  149.         -   The flag must be off to be accepted.
  150.         X   The flag must be on to be accepted.
  151.         ?   Don't care what the flag state is.
  152.  
  153.         Example:
  154.  
  155.          ---X--X- ?-??---- -------- --------
  156.  
  157.          To process this area record then Flags A4 and A7 must be on.
  158.          Flags A1-A3, A5-A6, A8 must be off.  Flags B2, B4-B8, C1-C8, D1-D8
  159.          must be off.  The state of Flags B1, B3-B4 are disregarded.
  160.  
  161.  
  162.     b.  How to run RaFbStat:
  163.  
  164.         Usage:  RaFbStat [<-F Path>]
  165.  
  166.           -F Path   - Using this argument will allow you to specify
  167.                       a different path for the .CTL file other than
  168.                       the default RAFBSTAT.CTL.
  169.  
  170.     c.  RaFbStat.Exe need not exist in the RA System directory to
  171.         generate the bulletin(s).  But if your are executing RaFbStat
  172.         without any arguments, then RaFbStat.Ctl must exist in the
  173.         current directory you are executing it from.
  174.  
  175.  
  176. Note:  If you have areas that are not in use, then make sure that they contain
  177.        no characters in the name or File Path description of the FILES.RA 
  178.        record for that area.
  179.  
  180.  
  181. 6.  Problem(s) History:
  182.  
  183.      10/08/90 - First Release.
  184.      v1.0
  185.  
  186.      10/09/90 - Bug.  Run time error 200 occurred at 0000:1D17.  This was
  187.      v1.1             cause by the grand total files being a zero value and
  188.                       being divided into the file count for the area to
  189.                       produce the percentage.  
  190.  
  191.                 Fix.  Put a trap in the code to not divide when Grand Total
  192.                       is zero.
  193.  
  194.      10/13/90 - Bug.  I found that sometimes that the code used to find
  195.      v1.2             the files specified in the RaFbStat.Ctl file also
  196.                       included the directories where the files were in
  197.                       the Grand Total File Count.  Although this would
  198.                       not cause problems for anyone, it does randomly
  199.                       produce incorrect values.
  200.  
  201.                 Fix.  Checked file attribute for a directory entry and
  202.                       bypass tally logic if true.
  203.  
  204.  
  205.  
  206. Other Quality Software Products for SysOps are:
  207.  
  208. Magic name    Description
  209.  
  210. RaTop         Top 10 - 100 Users bulletin maker for RemoteAccess.
  211.  
  212. QuikTop       Top 10 - 100 Users bulletin maker for QuickBBS 2.62+            
  213.  
  214. OpusTop       Top 10 -100 Users bulletin maker for OPUS CBCS 1.1x.
  215.  
  216.  
  217. PROBLEMS:
  218.  
  219.    Please notify me immediately if you have any problems or
  220. suggestions about this program.  Enhancements are being incorporated
  221. all the time and your input is more vital to this process than you
  222. think.  You may write me, send Net-Mail or logon at the following address:
  223.  
  224. Foxtrot Software        
  225. C/- Byron Copeland                   The Foxtrot BBS
  226. 11 Y Street                          (914) 567-1814 @Fidonet 1:272/26
  227. New Windsor, Ny.                     24 hours a day!
  228. 12553
  229.  
  230.  
  231.  
  232. ACKNOLEDGEMENTS:
  233.  
  234. Thanks to the people that were patient and critical at times.  But who helped
  235. make this software a better product:
  236.  
  237. Jeff Doolittle   40:50/1 40:1914/11
  238. Jamie Ferrara    Pending
  239. Eddie Bryant     1:360/13
  240.  
  241.  
  242.                   Enjoy and thank you for your support!
  243.  
  244.  
  245.                                - End -
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284. 
  285.